Skip to content

feat: implementation of variance for halfnormal distribution #9636

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
shubham220420 wants to merge 9 commits into
base: develop
Choose a base branch
from
Open

feat: implementation of variance for halfnormal distribution #9636

shubham220420 wants to merge 9 commits into from
+1,960 −0

Conversation

@shubham220420
Copy link
Contributor

@shubham220420 shubham220420 commented Jan 8, 2026

Progresses: #9416

Description

What is the purpose of this pull request?

This pull request:

  • This PR adds implementation of variance calculation for half-normal distribution.

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

{{TODO: add disclosure if applicable}}

@stdlib-js/reviewers

@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Jan 8, 2026
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Jan 8, 2026 •
edited
Loading

Coverage Report

Package Statements Branches Functions Lines
stats/base/dists/halfnormal/variance $\color{green}165/165$
$\color{green}+0.00%$ 		$\color{green}8/8$
$\color{green}+0.00%$ 		$\color{green}2/2$
$\color{green}+0.00%$ 		$\color{green}165/165$
$\color{green}+0.00%$

The above coverage report was generated for the changes in this PR.

Planeshifter
Planeshifter requested changes Jan 11, 2026
View reviewed changes
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR!

Planeshifter
Planeshifter requested changes Jan 12, 2026
View reviewed changes
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be close to merging.

lib/node_modules/@stdlib/stats/base/dists/halfnormal/variance/README.md
- **mu**: `[in] double` mean.
- **lambda**: `[in] double` shape parameter.
- **sigma**: `[in] double` scale parameter.
- **return**: `[out] double` variance.
Copy link
Member

@Planeshifter Planeshifter Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The return value shouldn't be listed as an argument here; we only list the input parameters. The return type is already shown in the function signature below.

lib/node_modules/@stdlib/stats/base/dists/halfnormal/variance/test/test.native.js

tape( 'if provided `NaN`, the function returns `NaN`', opts, function test( t ) {
var y = variance( NaN );
t.strictEqual( isnan( y ), true, 'returns NaN' );
Copy link
Member

@Planeshifter Planeshifter Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The assertion message should be 'returns expected value' for consistency with other packages and with test.js.

Suggested change
t.strictEqual( isnan( y ), true, 'returns NaN' );
t.strictEqual( isnan( y ), true, 'returns expected value' );

lib/node_modules/@stdlib/stats/base/dists/halfnormal/variance/test/test.native.js
var y;

y = variance( 0.0 );
t.strictEqual( isnan( y ), true, 'returns NaN' );
Copy link
Member

@Planeshifter Planeshifter Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here - let's use 'returns expected value' for consistency.

Suggested change
t.strictEqual( isnan( y ), true, 'returns NaN' );
t.strictEqual( isnan( y ), true, 'returns expected value' );

lib/node_modules/@stdlib/stats/base/dists/halfnormal/variance/test/test.native.js
t.strictEqual( isnan( y ), true, 'returns NaN' );

y = variance( -1.0 );
t.strictEqual( isnan( y ), true, 'returns NaN' );
Copy link
Member

@Planeshifter Planeshifter Jan 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

Suggested change
t.strictEqual( isnan( y ), true, 'returns NaN' );
t.strictEqual( isnan( y ), true, 'returns expected value' );

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Planeshifter Planeshifter Planeshifter requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

Needs Review A pull request which needs code review. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@shubham220420 @stdlib-bot @Planeshifter